[NoQA] [Wave8] Breadcrumbs #32221

MaciejSWM · 2023-11-29T21:07:02Z

Details

In this PR:
Included: New Breadcrumbs component styled for all the platforms. And a storybook as well.
Not included: No navigation, no onPress events - makes sense to add them during integration with the rest of navigation PRs.

Usage:
This PR only creates <Breadcrumbs /> component but it doesn't render it anywhere. To render it, use code below in any place, for example in SidebarLinks.js:

// import
import Breadcrumbs from '@components/Breadcrumbs';
// import

return (
        <View style={[styles.m2]}>
            <Breadcrumbs
                breadcrumbs={[
                    {
                        type: CONST.BREADCRUMB_TYPE.ROOT,
                    },
                ]}
            />
            <Breadcrumbs
                breadcrumbs={[
                    {
                        type: CONST.BREADCRUMB_TYPE.ROOT,
                    },
                    {
                        text: 'Chats',
                    },
                ]}
            />
            <Breadcrumbs
                breadcrumbs={[
                    {
                        text: "Cathy's Croissants, nestled in the heart of the bustling city",
                        type: CONST.BREADCRUMB_TYPE.STRONG,
                    },
                ]}
            />
            <Breadcrumbs
                breadcrumbs={[
                    {
                        text: "Cathy's Croissants, nestled in the heart of the bustling city",
                        type: CONST.BREADCRUMB_TYPE.STRONG,
                    },
                    {
                        text: 'Super long second breadcrumb to show elipsis',
                    },
                ]}
            />
            <Breadcrumbs
                breadcrumbs={[
                    {
                        text: "Cathy's Croissants, nestled in the heart of the bustling city",
                        type: CONST.BREADCRUMB_TYPE.STRONG,
                    },
                    {
                        text: 'Super long second breadcrumb to show elipsis hiper long',
                    },
                ]}
            />
            <Breadcrumbs
                breadcrumbs={[
                    {
                        text: "Cathy's Croissants, in the bustling city",
                        type: CONST.BREADCRUMB_TYPE.STRONG,
                    },
                    {
                        text: 'Account Settings Preferences',
                    },
                ]}
            />
            <Breadcrumbs
                breadcrumbs={[
                    {
                        text: "Cathy's Croissants, in the bustling city ultra long",
                        type: CONST.BREADCRUMB_TYPE.STRONG,
                    },
                    {
                        text: 'Account Settings',
                    },
                ]}
            />
            <Breadcrumbs
                breadcrumbs={[
                    {
                        text: "Cathy's Croissants, in the bustling city",
                        type: CONST.BREADCRUMB_TYPE.STRONG,
                    },
                    {
                        text: 'Account Settings',
                    },
                ]}
            />
            <Breadcrumbs
                breadcrumbs={[
                    {
                        text: "Cathy's Croissants, in the bustling city",
                        type: CONST.BREADCRUMB_TYPE.STRONG,
                    },
                    {
                        text: 'Profile',
                    },
                ]}
            />
            <Breadcrumbs
                breadcrumbs={[
                    {
                        text: 'Cathedral misty mountains large lake opacity',
                        type: CONST.BREADCRUMB_TYPE.STRONG,
                    },
                    {
                        text: 'Me',
                    },
                ]}
            />
            <Breadcrumbs
                breadcrumbs={[
                    {
                        text: 'C',
                        type: CONST.BREADCRUMB_TYPE.STRONG,
                    },
                    {
                        text: 'A',
                    },
                ]}
            />
            <Breadcrumbs
                breadcrumbs={[
                    {
                        type: CONST.BREADCRUMB_TYPE.ROOT,
                    },
                    {
                        text: 'A',
                    },
                ]}
            />
        </View>
    );

Storybook:

Fixed Issues

$ #31766
PROPOSAL:

Tests

Verify that no errors appear in the JS console
Compare the sizes and spaces of Breadcrumbs component to Figma designs
Test on all platforms

Offline tests

Same as 'Tests'

QA Steps

Verify that no errors appear in the JS console
Compare the sizes and spaces of Breadcrumbs component to Figma designs
Test on all platforms

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

MaciejSWM · 2023-12-01T10:28:10Z

Question to design team - which alignment is correct? Not totally clear from Figma as sometimes there are +1/-1 pixel differences. See the Settings below for two possible options:

@mountiny @dannymcclain can you help me tag the right person from the design team?

dannymcclain · 2023-12-01T18:37:59Z

cc @Expensify/design
The spacing should be 4px between each item:

Also this is random and not totally related to the actual code implementation of this component, but could you update the backtick in "Cathy`s Croissants" to an apostrophe so it reads "Cathy's Croissants"? It just really bothers me 😂

MaciejSWM · 2023-12-04T11:28:15Z

Thx @dannymcclain. Now it's clear. I updated the screenshots in the issue description above. I also dropped the example usage in the app, so that now this PR doesn't render anything and can be merged to main.

melvin-bot · 2023-12-04T11:28:24Z

@aimane-chnaif Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

shawnborton · 2023-12-04T14:04:35Z

Also I think we want the / in our icon color and not textSupporting, right?

dannymcclain · 2023-12-04T14:06:02Z

Yes Shawn you're right—good catch!

aimane-chnaif

Code looks good. Testing

aimane-chnaif · 2023-12-15T16:25:21Z

src/components/Breadcrumbs.tsx

+                </Text>
+            )}
+
+            {secondaryBreadcrumb && (


Suggested change

{secondaryBreadcrumb && (

{!!secondaryBreadcrumb && (

Based on

I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
Btw, NAB as this is object

aimane-chnaif · 2023-12-15T16:27:16Z

src/styles/index.ts

+            position: 'absolute',
+            bottom: -8,
+            left: -8,
            height: 12,
+            width: 22,
            paddingLeft: 4,
            paddingRight: 4,
            alignItems: 'center',
+            zIndex: -1,


Just to confirm: env badge position is verified by design team?

diff:

I think this is not a blocker for the pr since the badge is only visible in dev or staging

ok QA team created dedicated GH for us 🙂 : #33283

aimane-chnaif · 2023-12-17T18:38:29Z

src/components/Breadcrumbs.tsx

+    breadcrumbs: [BreadcrumbHeader | BreadcrumbStrong, Breadcrumb | undefined];
+};
+
+function Breadcrumbs({breadcrumbs}: BreadcrumbsProps) {


NAB: since this is view component, would be good to add custom style prop as default, like all others. If you think it's never needed, that's 👌

@MaciejSWM can you add this possibly in some of your next PRs?

aimane-chnaif · 2023-12-17T18:59:05Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

aimane-chnaif

Looks good. A few NAB comments.

mountiny

Thanks, looks good, going to move this ahead

aimane-chnaif · 2023-12-18T11:18:25Z

conflicts

mountiny · 2023-12-18T11:19:16Z

ah interesting GN is not showing the files

MaciejSWM · 2023-12-18T11:53:54Z

@aimane-chnaif changes applied. Also I migrated the storybook to TS to mimick the Search.stories.tsx file.

Tested and still works. The additional style prop also works.

aimane-chnaif · 2023-12-18T12:27:55Z

storybook looks good!

storybook.mov

@mountiny ready to merge 🚀

mountiny

Thanks, lets move this along!

OSBotify · 2023-12-18T13:39:09Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-12-19T02:43:00Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.14-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

OSBotify · 2023-12-19T03:46:21Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.14-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-12-21T05:13:56Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.4.14-6 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

Ollyws · 2024-03-21T08:25:25Z

src/styles/index.ts

+        breadcrumb: {
+            color: theme.textSupporting,
+            fontSize: variables.fontSizeh1,
+            lineHeight: variables.lineHeightSizeh1,


Setting a fixed line height was causing mis-alignment issues when changing the font size, we fixed this in #36655

cubuspl42 · 2024-04-05T09:20:39Z

Coming from #38298

The "Expensify" / "Chats" text elements became misaligned after these changes

MaciejSWM added 15 commits November 28, 2023 18:37

Change size of Expensify logo

6f3fc56

Breadcrumbs WIP

ced4c37

Breadcrumb types

0bfd97e

Pixel perfect alignments

6c66b08

Align text on mobile devices

ce3c4ea

Handle DEV badge nicely

5209597

Add unique keys for each breadcrumb

fbd4789

Align text on mobile

1218a42

Unique key

a8a2e38

Fix missing key

857c104

Fix styles not being applied to header

737480f

Breadcrumbs storybook

08cd12b

Rename story

a81da06

Use theme instead of colors

87b5b5b

Remove explicit margin - use flex adjustments

125626a

MaciejSWM added 4 commits December 4, 2023 12:04

Single quote instead of backtick

694d6ad

Drop test breadcrumbs

1dba8b0

Pixel-perfect alignment

5dbffff

Drop unused import

8e3309c

MaciejSWM marked this pull request as ready for review December 4, 2023 11:28

MaciejSWM requested a review from a team as a code owner December 4, 2023 11:28

melvin-bot bot requested review from aimane-chnaif and removed request for a team December 4, 2023 11:28

Merge branch 'main' into wave8/breadcrumbs

9467923

aimane-chnaif reviewed Dec 15, 2023

View reviewed changes

aimane-chnaif reviewed Dec 17, 2023

View reviewed changes

aimane-chnaif approved these changes Dec 17, 2023

View reviewed changes

melvin-bot bot requested a review from mountiny December 17, 2023 18:59

mountiny previously approved these changes Dec 18, 2023

View reviewed changes

MaciejSWM added 6 commits December 18, 2023 12:37

Merge branch 'main' into wave8/breadcrumbs

e5cc42e

Convert object to boolean before doing AND on it

22864a4

Migrate Storybook file to TS

39784fb

Add optional style prop

f14e7b4

Export type to use in storybook

e0cef1a

Prop description

0d30c94

MaciejSWM dismissed mountiny’s stale review via 0d30c94 December 18, 2023 11:54

mountiny approved these changes Dec 18, 2023

View reviewed changes

mountiny merged commit c96a209 into Expensify:main Dec 18, 2023
16 checks passed

github-actions bot mentioned this pull request Dec 19, 2023

Deploy Checklist: New Expensify 2023-12-19 #33264

Closed

98 tasks

paultsimura mentioned this pull request Dec 19, 2023

Sign In - "STG" label displayed on the right side against "Expensify" label on Sign In page #33283

Closed

6 tasks

melvin-bot bot mentioned this pull request Dec 21, 2023

[HOLD for payment 2023-12-29] [HOLD for payment 2023-12-28] [Ideal Nav] Create components for the ideal nav #31766

Closed

10 tasks

MahmudjonToraqulov mentioned this pull request Mar 14, 2024

[HOLD for payment 2024-04-05] [$250] Chats - Expensify / Chats is not aligned on the same line #38298

Closed

6 tasks

Ollyws reviewed Mar 21, 2024

View reviewed changes

Ollyws mentioned this pull request Mar 21, 2024

[HOLD for payment 2024-03-20] [$500] Workspace - Title with /Chats and /Settings is not aligned properly with minimum font size #35785

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NoQA] [Wave8] Breadcrumbs #32221

[NoQA] [Wave8] Breadcrumbs #32221

MaciejSWM commented Nov 29, 2023 •

edited

Loading

MaciejSWM commented Dec 1, 2023 •

edited

Loading

dannymcclain commented Dec 1, 2023

MaciejSWM commented Dec 4, 2023

melvin-bot bot commented Dec 4, 2023

shawnborton commented Dec 4, 2023

dannymcclain commented Dec 4, 2023

aimane-chnaif left a comment

aimane-chnaif Dec 15, 2023

aimane-chnaif Dec 15, 2023 •

edited

Loading

mountiny Dec 18, 2023

aimane-chnaif Dec 19, 2023

aimane-chnaif Dec 17, 2023

mountiny Dec 18, 2023

aimane-chnaif commented Dec 17, 2023

aimane-chnaif left a comment

mountiny left a comment

aimane-chnaif commented Dec 18, 2023

mountiny commented Dec 18, 2023

MaciejSWM commented Dec 18, 2023

aimane-chnaif commented Dec 18, 2023

mountiny left a comment

OSBotify commented Dec 18, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 21, 2023

Ollyws Mar 21, 2024

cubuspl42 commented Apr 5, 2024

[NoQA] [Wave8] Breadcrumbs #32221

[NoQA] [Wave8] Breadcrumbs #32221

Conversation

MaciejSWM commented Nov 29, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MaciejSWM commented Dec 1, 2023 • edited Loading

dannymcclain commented Dec 1, 2023

MaciejSWM commented Dec 4, 2023

melvin-bot bot commented Dec 4, 2023

shawnborton commented Dec 4, 2023

dannymcclain commented Dec 4, 2023

aimane-chnaif left a comment

Choose a reason for hiding this comment

aimane-chnaif Dec 15, 2023

Choose a reason for hiding this comment

aimane-chnaif Dec 15, 2023 • edited Loading

Choose a reason for hiding this comment

mountiny Dec 18, 2023

Choose a reason for hiding this comment

aimane-chnaif Dec 19, 2023

Choose a reason for hiding this comment

aimane-chnaif Dec 17, 2023

Choose a reason for hiding this comment

mountiny Dec 18, 2023

Choose a reason for hiding this comment

aimane-chnaif commented Dec 17, 2023

Reviewer Checklist

Screenshots/Videos

aimane-chnaif left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

aimane-chnaif commented Dec 18, 2023

mountiny commented Dec 18, 2023

MaciejSWM commented Dec 18, 2023

aimane-chnaif commented Dec 18, 2023

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 18, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 21, 2023

Ollyws Mar 21, 2024

Choose a reason for hiding this comment

cubuspl42 commented Apr 5, 2024

MaciejSWM commented Nov 29, 2023 •

edited

Loading

MaciejSWM commented Dec 1, 2023 •

edited

Loading

aimane-chnaif Dec 15, 2023 •

edited

Loading